JOSS paper: updated-scope paper.md + draft-pdf compile workflow#25
Merged
Conversation
Adds a workflow_dispatch + paper-change-triggered job that runs the Open Journals Pandoc pipeline (journal=joss) over the repo-root paper.md and uploads paper.pdf as a build artifact, so the JOSS proof PDF can be verified before submission.
Adds the now-required Software design, Research impact statement, and AI usage disclosure sections; strengthens State of the field with a build-vs-contribute justification; adds a financial-support statement; expands the body to 1064 words (updated JOSS range is 750-1750).
mypy 2.1.0 errors on numpy>=2.5 .pyi files ('Type statement is only
supported in Python 3.12 and greater') under the configured py3.10
type target, breaking the typecheck gate. Pin below 2.1 until the
stub/target interaction is resolved upstream.
The typecheck break is numpy 2.5.0's stubs using PEP 695 'type' statements, which mypy rejects under the py3.10 target regardless of mypy version (2.0 and 2.1 both fail). Revert the ineffective mypy<2.1 cap and instead bound numpy<2.5 in the dev extra only; runtime deps stay unconstrained for end users.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
.github/workflows/draft-pdf.yml: runs the Open Journals Pandoc pipeline (journal: joss) over the repo-rootpaper.mdand uploadspaper.pdfas a build artifact.Purpose: produce the JOSS proof PDF so the "I have verified that my paper compiles" requirement on the submission form can be confirmed. Triggers on manual dispatch and on changes to
paper.md/paper.bib.The push that created this branch already triggered a run — the compiled
paper.pdfis downloadable from that run's Artifacts.